home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1993 / Internet Info CD-ROM (Walnut Creek) (1993).iso / inet / internet-drafts / draft-ietf-telnet-envmnt-option-02.txt < prev    next >
Text File  |  1993-10-08  |  15KB  |  403 lines
  1.  
  2. Network Working Group                               S. Alexander, Editor
  3. Internet-Draft                                  Lachman Technology, Inc.
  4. <draft-ietf-telnet-envmnt-option-02.txt>                    October 1993
  5.  
  6.  
  7.                        Telnet Environment Option
  8.  
  9. Status of this Memo
  10.  
  11.    This document is an Internet Draft.  Internet Drafts are working
  12.    documents of the Internet Engineering Task Force (IETF), its Areas,
  13.    and its Working Groups. Note that other groups may also distribute
  14.    working documents as Internet Drafts.
  15.  
  16.    Internet Drafts are draft documents valid for a maximum of six
  17.    months. Internet Drafts may be updated, replaced, or obsoleted by
  18.    other documents at any time.  It is not appropriate to use Internet
  19.    Drafts as reference material or to cite them other than as a "working
  20.    draft" or "work in progress."
  21.  
  22.    Please check the 1id-abstracts.txt listing contained in the
  23.    internet-drafts Shadow Directories on nic.ddn.mil, nnsc.nsf.net,
  24.    nic.nordu.net, ftp.nisc.sri.com, or munnari.oz.au to learn the
  25.    current status of any Internet Draft.
  26.  
  27.    This memo is found in file "draft-ietf-telnet-envmnt-option-02.txt".
  28.  
  29. Abstract
  30.  
  31.    This document specifies a mechanism for passing environment
  32.    information between a telnet client and server.  Use of this
  33.    mechanism enables a telnet user to propagate configuration
  34.    information to a remote host when connecting.
  35.  
  36.    This document corrects some errors in [1].
  37.  
  38. 1.  Command Names and Codes
  39.  
  40.       ENVIRON         39
  41.           IS               0
  42.           SEND             1
  43.           INFO             2
  44.  
  45.           VAR              0
  46.           VALUE            1
  47.           ESC              2
  48.           USERVAR          3
  49.  
  50.  
  51.  
  52.                            Expires April 1994                   [Page 1]
  53.  
  54. Internet-Draft         Telnet Environment Option            October 1993
  55.  
  56.  
  57.  
  58. 2.  Command Meanings
  59.  
  60.    IAC WILL ENVIRON
  61.  
  62.       The sender of this command is willing to send environment
  63.       variables.
  64.  
  65.    IAC WONT ENVIRON
  66.  
  67.       The sender of this command refuses to send environment variables.
  68.  
  69.    IAC DO ENVIRON
  70.  
  71.       The sender of this command is willing to receive environment
  72.       variables.
  73.  
  74.    IAC DONT ENVIRON
  75.  
  76.       The sender of this command refuses to accept environment
  77.       variables.
  78.  
  79.    IAC SB ENVIRON SEND [ type ... [ type ... [ ... ] ] ] IAC SE
  80.  
  81.       The sender of this command requests that the remote side send its
  82.       environment variables.  The "type" may be either VAR or USERVAR,
  83.       to indicate either well known or user variable names.  Only the
  84.       side that is DO ENVIRON may initiate a SEND command.  If a list of
  85.       variables is specified, then only those variables should be sent.
  86.       If no list is specified, then the default environment, of both
  87.       well known and user defined variables, should be sent.  If one of
  88.       the variables has no name, then all the variables of that type
  89.       (well known or user defined)  in the default environment should be
  90.       sent.
  91.  
  92.    IAC SB ENVIRON IS type ... [ VALUE ... ] [ type ... [ VALUE ... ] [
  93.    ... ] ] IAC SE
  94.  
  95.       The sender of this command is sending environment variables.  This
  96.       command is sent in response to a SEND request.  Only the side that
  97.       is WILL ENVIRON may send an IS command.  The "type"/VALUE pairs
  98.       must be returned in the same order as the SEND request specified
  99.       them, and there must be a response for each "type ..." explicitly
  100.       requested.  The "type" will be VAR or USERVAR.  Multiple
  101.       environment variables may be sent.  The characters following a
  102.       "type" up to the next "type" or VALUE specify the variable name.
  103.       The characters following a VALUE up to the next "type" specify the
  104.       value of the variable.  If a "type" is not followed by a VALUE
  105.       (e.g., by another VAR, USERVAR, or IAC SE) then that variable is
  106.       undefined.  If a VALUE is immediately followed by a "type" or IAC,
  107.  
  108.  
  109.  
  110.                            Expires April 1994                   [Page 2]
  111.  
  112. Internet-Draft         Telnet Environment Option            October 1993
  113.  
  114.  
  115.       then the variable is defined, but has no value.  If an IAC is
  116.       contained between the IS and the IAC SE, it must be sent as IAC
  117.       IAC.  If a variable or a value contains a VAR, it must be sent as
  118.       ESC VAR.  If a variable or a value contains a USERVAR, it must be
  119.       sent as ESC USERVAR.  If a variable or a value contains a VALUE,
  120.       it must be sent as ESC VALUE.  If a variable or a value contains
  121.       an ESC, it must be sent as ESC ESC.
  122.  
  123.    IAC SB ENVIRON INFO type ... [ VALUE ... ] [ type ... [ VALUE ... ] [
  124.    ... ] ] IAC SE
  125.  
  126.       The sender of this command is sending information about
  127.       environment variables that have changed.  It is identical to the
  128.       IS command, except that the command is INFO instead of IS.  Only
  129.       the side that is WILL ENVIRON may send an INFO command.  The INFO
  130.       command is not to be used to send initial information; the SEND/IS
  131.       sequence is to be used for that.  The INFO command is to be used
  132.       to propagate changes in environment variables, and may be
  133.       spontaneously generated.
  134.  
  135.  
  136. 3.  Default Specification
  137.  
  138.    The default specification for this option is
  139.  
  140.       WONT ENVIRON
  141.       DONT ENVIRON
  142.  
  143.    meaning there will not be any exchange of environment information.
  144.  
  145. 4.  Motivation
  146.  
  147.    Many operating systems have startup information and environment
  148.    variables that contain information that should be propagated to
  149.    remote machines when Telnet connections are established.  Rather than
  150.    create a new Telnet option each time someone comes up with some new
  151.    information that they need propagated through a Telnet session, but
  152.    that the Telnet session itself doesn't really need to know about,
  153.    this generic information option can be used.
  154.  
  155. 5.  Well Known Variables
  156.  
  157.    USER        This variable is used to transmit the user or account
  158.                name that the client wishes to log into on the remote
  159.                system.  The format of the value the USER variable is
  160.                system dependent, as determined by the remote system.
  161.  
  162.    JOB         This variable is used to transmit the job ID that the
  163.                client wishes to use when logging into the remote system.
  164.                The format of the value the JOB variable is system
  165.  
  166.  
  167.  
  168.                            Expires April 1994                   [Page 3]
  169.  
  170. Internet-Draft         Telnet Environment Option            October 1993
  171.  
  172.  
  173.                dependent, as determined by the remote system.
  174.  
  175.    ACCT        This variable is used to transmit the account ID that the
  176.                client wishes to use when logging into the remote system.
  177.                The format of the value the ACCT variable is system
  178.                dependent, as determined by the remote system.
  179.  
  180.    PRINTER     This variable is used to identify the default location
  181.                for printer output.  Because there does not currently
  182.                exist a standard way of naming a printer on a network,
  183.                the format of this variable is currently undefined.
  184.  
  185.    SYSTEMTYPE  This is used to transmit the type of operating system on
  186.                the system that sends this variable.  It value is
  187.                identical to the value of the SYSTEM (SYST) command in
  188.                FTP [4].  The format of the value shall have as its first
  189.                word one of the system names listed in the current
  190.                version of the Assigned Numbers document [5].
  191.  
  192.    DISPLAY     This variable is used to transmit the X display location
  193.                of the client.  The format for the value of the DISPLAY
  194.                variable is:
  195.                   <host>:<dispnum>[.<screennum>]
  196.                This information is identical to the information passed
  197.                using the Telnet X-DISPLAY-LOCATION option.  If both the
  198.                DISPLAY environment variable, and the X-DISPLAY-LOCATION
  199.                option [6] are received, and they contain conflicting
  200.                information, the most recently received information
  201.                received should be used.
  202.  
  203.  
  204.    Because it is impossible to anticipate all variables that users may
  205.    wish to exchange, the USERVAR type is provided to allow users to
  206.    transmit arbitrary variable/value pairs.  The use of an additional
  207.    type allows implementations to distinguish between values derived by
  208.    the remote host software and values supplied by the user.  Paranoid
  209.    implementations will most likely treat both types with an equal level
  210.    of distrust.  The results of a name-space collision between a well-
  211.    known and a user variable are implementation specific.
  212.  
  213. 6.  Implementation Rules
  214.  
  215.    WILL and DO are used only at the beginning of the connection to
  216.    obtain and grant permission for future negotiations.
  217.  
  218.    Once the two hosts have exchanged a WILL and a DO, the sender of the
  219.    DO ENVIRON is free to request that environment variables be sent.
  220.    Only the sender of the DO may send requests (IAC SB ENVIRON SEND IAC
  221.    SE) and only the sender of the WILL may transmit actual environment
  222.    information (via the IAC SB ENVIRON IS ... IAC SE command).  Though
  223.  
  224.  
  225.  
  226.                            Expires April 1994                   [Page 4]
  227.  
  228. Internet-Draft         Telnet Environment Option            October 1993
  229.  
  230.  
  231.    this option may be used at any time throughout the life of the telnet
  232.    connection, the exchange of environment information will usually
  233.    happen at the startup of the connection.  This is because many
  234.    operating systems only have mechanisms for propagating environment
  235.    information at process creation, so the information is needed before
  236.    the user logs in.
  237.  
  238.    The receiving host is not required to put all variables that it
  239.    receives into the environment.  For example, if the client should
  240.    send across USERVAR "TERM" VALUE "xterm" as an environment variable,
  241.    and the TERMINAL-TYPE [3] option has already been used to determine
  242.    the terminal type, the server may safely ignore the TERM variable.
  243.    Also, some startup information may be used in other ways; for
  244.    example, the values for "USER", "ACCT" and "PROJ" values might be
  245.    used to decide which account to log into, and might never be put into
  246.    the users environment.  In general, if the server has already
  247.    determined the value of an environment variable by some more accurate
  248.    means, or if it does not understand a variable name, it may ignore
  249.    the value sent in the ENVIRON option.  The server may also prefer to
  250.    just put all unknown information into the users environment.  This is
  251.    the suggested method of implementation, because it allows the user
  252.    the most flexibility.
  253.  
  254.    The following is an example of use of the option:
  255.  
  256.        Host1                            Host2
  257.        IAC DO ENVIRON
  258.                                         IAC WILL ENVIRON
  259.        [ Host1 is now free to request environment information ]
  260.        IAC SB ENVIRON SEND VAR "USER"
  261.        VAR "ACCT" VAR USERVAR IAC SE
  262.        [ The server has now explicitly asked for the USER and ACCT
  263.          variables, the default set of well known environment variables,
  264.          and the default set of user defined variables.  Note that the
  265.          client includes the USER information twice; once because it was
  266.          explicitly asked for, and once because it is part of the
  267.          default environment.  ]
  268.                                         IAC SB ENVIRON IS VAR "USER"
  269.                                         VALUE "joe" VAR "ACCT" VALUE
  270.                                         "kernel" VAR "USER" VALUE "joe"
  271.                                         VAR "DISPLAY" VALUE "foo:0.0"
  272.                                         USERVAR "SHELL" VALUE "/bin/csh"
  273.                                         IAC SE
  274.  
  275.    It is legal for a client to respond with an empty environment (no
  276.    data between the IAC SB and IAC SE) when no well-defined or user
  277.    variables are currently defined.  For example:
  278.  
  279.       IAC SB ENVIRON IS IAC SE
  280.  
  281.  
  282.  
  283.  
  284.                            Expires April 1994                   [Page 5]
  285.  
  286. Internet-Draft         Telnet Environment Option            October 1993
  287.  
  288.  
  289.    is a valid response to any of the following:
  290.  
  291.       IAC SB ENVIRON SEND IAC SE
  292.       IAC SB ENVIRON SEND VAR IAC SE
  293.       IAC SB ENVIRON SEND USERVAR IAC SE
  294.       IAC SB ENVIRON SEND VAR USERVAR IAC SE
  295.  
  296.    (The last example is equivalent to the first...)
  297.  
  298.    The earlier version of this specification [1] incorrectly reversed
  299.    the values for VAR and VALUE,  which this put the specification at
  300.    odds with existing implementations.  In order to resolve that
  301.    problem, as well as other minor problems, a new option number has
  302.    been assigned to the ENVIRON option.  This allows implementations of
  303.    this memo to interoperate with no ambiguity.
  304.  
  305.    For a discussion on how to implement to interoperate with the various
  306.    implementations that pre-date this memo, see [2].
  307.  
  308.    It is expected that any implementation that supports the Telnet
  309.    ENVIRON option will support all of this specification.
  310.  
  311. 7.  Security Concerns
  312.  
  313.    It is important for an implementor of the ENVIRON option to
  314.    understand the interaction of setting options and the
  315.    login/authentication process. Specifically careful analysis should be
  316.    done to determine which variables are "safe" to set prior to having
  317.    the client login.  An example of a bad choice would be permitting a
  318.    variable to be changed that allows an intruder to circumvent or
  319.    compromise the login/authentication program itself.
  320.  
  321. 8.  References
  322.  
  323.    [1] Borman, D., "Telnet Environment Option", RFC 1408, Cray Research,
  324.        Inc., January 1993.
  325.  
  326.    [2] Borman, D., "Telnet Environment Option Interoperability Issues",
  327.        Internet Draft, Cray Research, Inc., April 1993.
  328.  
  329.    [3] VanBokkelen, J., "Telnet Terminal-Type Option", RFC 1091, FTP
  330.        Software, Inc., February 1989.
  331.  
  332.    [4] Postel, J. and J. Reynolds, "File Transfer Protocol (FTP)", STD
  333.        9, RFC 959, USC/Information Sciences Institute, October 1985.
  334.  
  335.    [5] Reynolds, J. and J. Postel, "Assigned Numbers", STD 2, RFC 1340,
  336.        USC/Information Sciences Institute, July 1992.
  337.  
  338.    [6] Marcy, G., "Telnet X Display Location Option", RFC 1096, Carnegie
  339.  
  340.  
  341.  
  342.                            Expires April 1994                   [Page 6]
  343.  
  344. Internet-Draft         Telnet Environment Option            October 1993
  345.  
  346.  
  347.        Mellon University, March 1989.
  348.  
  349. Acknowledgements
  350.  
  351.    The original version of this document was written by Dave Borman of
  352.    Cray Research, Inc.  In addition, the comments of the Telnet Working
  353.    Group are gratefully acknowledged.
  354.  
  355. Security Considerations
  356.  
  357.    Security issues are discussed in Section 7.
  358.  
  359. Editor's Address
  360.  
  361.    Steve Alexander
  362.    Lachman Technology, Inc.
  363.    1901 North Naper Boulevard
  364.    Naperville, IL 60563-8895
  365.  
  366.    Phone: (708) 505-9555 x256
  367.    EMail: stevea@lachman.com
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.                            Expires April 1994                   [Page 7]
  401.  
  402.  
  403.